<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>lwIP: ACD</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">lwIP
   &#160;<span id="projectnumber">2.2.0</span>
   </div>
   <div id="projectbrief">Lightweight IP stack</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__acd.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">ACD<div class="ingroups"><a class="el" href="group__api.html">APIs</a> &raquo; <a class="el" href="group__callbackstyle__api.html">&quot;raw&quot; APIs</a> &raquo; <a class="el" href="group__ip.html">IP</a> &raquo; <a class="el" href="group__ip4.html">IPv4</a></div></div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga158856bf139cb2761837ddfa07303bdc"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__infrastructure__errors.html#gaf02d9da80fd66b4f986d2c53d7231ddb">err_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__acd.html#ga158856bf139cb2761837ddfa07303bdc">acd_add</a> (struct <a class="el" href="structnetif.html">netif</a> *<a class="el" href="structnetif.html">netif</a>, struct <a class="el" href="structacd.html">acd</a> *<a class="el" href="structacd.html">acd</a>, <a class="el" href="acd_8h.html#abb446404752f56b028eafa8302db955f">acd_conflict_callback_t</a> acd_conflict_callback)</td></tr>
<tr class="separator:ga158856bf139cb2761837ddfa07303bdc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga70503696bca25e1cfb61fad38b4327da"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__acd.html#ga70503696bca25e1cfb61fad38b4327da">acd_remove</a> (struct <a class="el" href="structnetif.html">netif</a> *<a class="el" href="structnetif.html">netif</a>, struct <a class="el" href="structacd.html">acd</a> *<a class="el" href="structacd.html">acd</a>)</td></tr>
<tr class="separator:ga70503696bca25e1cfb61fad38b4327da"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2ca2e2dbb9713f90515d443dc691b5cb"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__infrastructure__errors.html#gaf02d9da80fd66b4f986d2c53d7231ddb">err_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__acd.html#ga2ca2e2dbb9713f90515d443dc691b5cb">acd_start</a> (struct <a class="el" href="structnetif.html">netif</a> *<a class="el" href="structnetif.html">netif</a>, struct <a class="el" href="structacd.html">acd</a> *<a class="el" href="structacd.html">acd</a>, <a class="el" href="ip4__addr_8h.html#a3d3b45daffbc15d65da236e31e621b7e">ip4_addr_t</a> ipaddr)</td></tr>
<tr class="separator:ga2ca2e2dbb9713f90515d443dc691b5cb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga36da2b23951a14ca3c92f5e78db2f1b7"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__infrastructure__errors.html#gaf02d9da80fd66b4f986d2c53d7231ddb">err_t</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__acd.html#ga36da2b23951a14ca3c92f5e78db2f1b7">acd_stop</a> (struct <a class="el" href="structacd.html">acd</a> *<a class="el" href="structacd.html">acd</a>)</td></tr>
<tr class="separator:ga36da2b23951a14ca3c92f5e78db2f1b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga2872fa375f9cd8f5b095639d652f6bff"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__acd.html#ga2872fa375f9cd8f5b095639d652f6bff">acd_network_changed_link_down</a> (struct <a class="el" href="structnetif.html">netif</a> *<a class="el" href="structnetif.html">netif</a>)</td></tr>
<tr class="separator:ga2872fa375f9cd8f5b095639d652f6bff"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga18b444f6fc69325416b463208a754c97"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__acd.html#ga18b444f6fc69325416b463208a754c97">acd_netif_ip_addr_changed</a> (struct <a class="el" href="structnetif.html">netif</a> *<a class="el" href="structnetif.html">netif</a>, const <a class="el" href="group__ipaddr.html#ga16ef96d6cde029029bbf47fee35fd67a">ip_addr_t</a> *old_addr, const <a class="el" href="group__ipaddr.html#ga16ef96d6cde029029bbf47fee35fd67a">ip_addr_t</a> *new_addr)</td></tr>
<tr class="separator:ga18b444f6fc69325416b463208a754c97"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p>ACD related functions USAGE:</p>
<p>define <a class="el" href="group__lwip__opts__acd.html#ga6f1667866335cad3a7b1221bd0b274e7">LWIP_ACD</a> 1 in your lwipopts.h Options: ACD_TMR_INTERVAL msecs, I recommend a value of 100. The value must divide 1000 with a remainder almost 0. Possible values are 1000, 500, 333, 250, 200, 166, 142, 125, 111, 100 ....</p>
<p>For fixed IP:</p><ul>
<li>call acd_start after selecting an IP address. The caller will be informed on conflict status via the callback function.</li>
</ul>
<p>With AUTOIP:</p><ul>
<li>will be called from the autoip module. No extra's needed.</li>
</ul>
<p>With DHCP:</p><ul>
<li>enable LWIP_DHCP_DOES_ACD_CHECK. Then it will be called from the dhcp module. No extra's needed. </li>
</ul>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga158856bf139cb2761837ddfa07303bdc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga158856bf139cb2761837ddfa07303bdc">&#9670;&nbsp;</a></span>acd_add()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__infrastructure__errors.html#gaf02d9da80fd66b4f986d2c53d7231ddb">err_t</a> acd_add </td>
          <td>(</td>
          <td class="paramtype">struct <a class="el" href="structnetif.html">netif</a> *&#160;</td>
          <td class="paramname"><em>netif</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">struct <a class="el" href="structacd.html">acd</a> *&#160;</td>
          <td class="paramname"><em>acd</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="acd_8h.html#abb446404752f56b028eafa8302db955f">acd_conflict_callback_t</a>&#160;</td>
          <td class="paramname"><em>acd_conflict_callback</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Add ACD client to the client list and initialize callback function</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">netif</td><td>network interface on which to start the acd client </td></tr>
    <tr><td class="paramname">acd</td><td>acd module to be added to the list </td></tr>
    <tr><td class="paramname">acd_conflict_callback</td><td>callback to be called when conflict information is available </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga18b444f6fc69325416b463208a754c97"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga18b444f6fc69325416b463208a754c97">&#9670;&nbsp;</a></span>acd_netif_ip_addr_changed()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void acd_netif_ip_addr_changed </td>
          <td>(</td>
          <td class="paramtype">struct <a class="el" href="structnetif.html">netif</a> *&#160;</td>
          <td class="paramname"><em>netif</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="group__ipaddr.html#ga16ef96d6cde029029bbf47fee35fd67a">ip_addr_t</a> *&#160;</td>
          <td class="paramname"><em>old_addr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const <a class="el" href="group__ipaddr.html#ga16ef96d6cde029029bbf47fee35fd67a">ip_addr_t</a> *&#160;</td>
          <td class="paramname"><em>new_addr</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Inform the ACD modules of address changes</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">netif</td><td>network interface on which the address is changing </td></tr>
    <tr><td class="paramname">old_addr</td><td>old ip address </td></tr>
    <tr><td class="paramname">new_addr</td><td>new ip address </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga2872fa375f9cd8f5b095639d652f6bff"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga2872fa375f9cd8f5b095639d652f6bff">&#9670;&nbsp;</a></span>acd_network_changed_link_down()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void acd_network_changed_link_down </td>
          <td>(</td>
          <td class="paramtype">struct <a class="el" href="structnetif.html">netif</a> *&#160;</td>
          <td class="paramname"><em>netif</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Inform the ACD modules when the link goes down</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">netif</td><td>network interface on which to inform the ACD clients </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga70503696bca25e1cfb61fad38b4327da"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga70503696bca25e1cfb61fad38b4327da">&#9670;&nbsp;</a></span>acd_remove()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void acd_remove </td>
          <td>(</td>
          <td class="paramtype">struct <a class="el" href="structnetif.html">netif</a> *&#160;</td>
          <td class="paramname"><em>netif</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">struct <a class="el" href="structacd.html">acd</a> *&#160;</td>
          <td class="paramname"><em>acd</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Remvoe ACD client from the client list</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">netif</td><td>network interface from which to remove the acd client </td></tr>
    <tr><td class="paramname">acd</td><td>acd module to be removed from the list </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga2ca2e2dbb9713f90515d443dc691b5cb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga2ca2e2dbb9713f90515d443dc691b5cb">&#9670;&nbsp;</a></span>acd_start()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__infrastructure__errors.html#gaf02d9da80fd66b4f986d2c53d7231ddb">err_t</a> acd_start </td>
          <td>(</td>
          <td class="paramtype">struct <a class="el" href="structnetif.html">netif</a> *&#160;</td>
          <td class="paramname"><em>netif</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">struct <a class="el" href="structacd.html">acd</a> *&#160;</td>
          <td class="paramname"><em>acd</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="ip4__addr_8h.html#a3d3b45daffbc15d65da236e31e621b7e">ip4_addr_t</a>&#160;</td>
          <td class="paramname"><em>ipaddr</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Start ACD client</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">netif</td><td>network interface on which to start the acd client </td></tr>
    <tr><td class="paramname">acd</td><td>acd module to start </td></tr>
    <tr><td class="paramname">ipaddr</td><td>ip address to perform acd on </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="ga36da2b23951a14ca3c92f5e78db2f1b7"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga36da2b23951a14ca3c92f5e78db2f1b7">&#9670;&nbsp;</a></span>acd_stop()</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__infrastructure__errors.html#gaf02d9da80fd66b4f986d2c53d7231ddb">err_t</a> acd_stop </td>
          <td>(</td>
          <td class="paramtype">struct <a class="el" href="structacd.html">acd</a> *&#160;</td>
          <td class="paramname"><em>acd</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Stop ACD client</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">acd</td><td>acd module to stop </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="footer">Generated by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li>
  </ul>
</div>
</body>
</html>
